FrameLib  2.0
DSP processing with frames of arbitrary timing and length
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameLib_Scheduler Class Reference
Processing Objects

a convenience class for creating scheduler type FrameLib_DSP classes. More...

#include <FrameLib_DSP.h>

Inheritance diagram for FrameLib_Scheduler:
FrameLib_DSP FrameLib_Block FrameLib_Queueable< FrameLib_DSP > FrameLib_Object< FrameLib_Block > FrameLib_Queueable< FrameLib_Block >

Public Member Functions

 FrameLib_Scheduler (FrameLib_Context context, FrameLib_Proxy *proxy, FrameLib_Parameters::Info *info, unsigned long nIns=0, unsigned long nOuts=0, unsigned long nAudioIns=0)
 
- Public Member Functions inherited from FrameLib_DSP
 FrameLib_DSP (ObjectType type, FrameLib_Context context, FrameLib_Proxy *proxy, FrameLib_Parameters::Info *info, unsigned long nIns, unsigned long nOuts, unsigned long nAudioChans=0)
 
 ~FrameLib_DSP ()
 
 FrameLib_DSP (const FrameLib_DSP &)=delete
 
FrameLib_DSP & operator= (const FrameLib_DSP &)=delete
 
void setFixedInput (unsigned long idx, double *input, unsigned long size) final
 
const double * getFixedInput (unsigned long idx, unsigned long *size) final
 
void blockUpdate (const double *const *ins, double **outs, unsigned long blockSize) final
 
void reset (double samplingRate, unsigned long maxBlockSize) final
 
const FrameLib_Parameters * getParameters () const final
 
FrameType inputType (unsigned long idx) const final
 
FrameType outputType (unsigned long idx) const final
 
void autoOrderingConnections () final
 
void clearAutoOrderingConnections () final
 
- Public Member Functions inherited from FrameLib_Block
 FrameLib_Block (ObjectType type, FrameLib_Context context, FrameLib_Proxy *proxy)
 
virtual ~FrameLib_Block ()
 
virtual void setStream (void *streamOwner, unsigned long stream)
 
- Public Member Functions inherited from FrameLib_Object< FrameLib_Block >
 FrameLib_Object (ObjectType type, FrameLib_Context context, FrameLib_Proxy *proxy)
 
virtual ~FrameLib_Object ()
 
ObjectType getType () const
 
FrameLib_Context getContext () const
 
FrameLib_Proxy * getProxy () const
 
unsigned long getNumIns () const
 
unsigned long getNumOuts () const
 
unsigned long getNumAudioIns () const
 
unsigned long getNumAudioOuts () const
 
unsigned long getNumAudioChans () const
 
virtual std::string objectInfo (bool verbose=false)
 
virtual std::string inputInfo (unsigned long idx, bool verbose=false)
 
virtual std::string outputInfo (unsigned long idx, bool verbose=false)
 
virtual std::string audioInfo (unsigned long idx, bool verbose=false)
 
ConnectionResult addConnection (Connection connection, unsigned long inIdx)
 
void deleteConnection (unsigned long inIdx)
 
ConnectionResult addOrderingConnection (Connection connection)
 
void deleteOrderingConnection (Connection connection)
 
void clearOrderingConnections ()
 
void clearConnections ()
 
ConnectionResult setInputAlias (Connection alias, unsigned long inIdx)
 
ConnectionResult setOrderingAlias (FrameLib_Block *alias)
 
ConnectionResult setOutputAlias (Connection alias, unsigned long outIdx)
 
bool isConnected (unsigned long inIdx) const
 
Connection getConnection (unsigned long inIdx) const
 
bool supportsOrderingConnections () const
 
unsigned long getNumOrderingConnections () const
 
Connection getOrderingConnection (unsigned long idx) const
 
void callConnectionUpdate ()
 
void addOutputDependencies (std::vector< U * > &dependencies)
 
void addOutputDependencies (std::vector< U * > &dependencies, unsigned long outIdx)
 
- Public Member Functions inherited from FrameLib_Queueable< FrameLib_Block >
 FrameLib_Queueable ()
 
- Public Member Functions inherited from FrameLib_Queueable< FrameLib_DSP >
 FrameLib_Queueable ()
 

Static Public Member Functions

static ObjectType getType ()
 
static bool handlesAudio ()
 
- Static Public Member Functions inherited from FrameLib_Object< FrameLib_Block >
static bool handlesAudio ()
 

Protected Member Functions

virtual void process ()
 
- Protected Member Functions inherited from FrameLib_DSP
void setIO (unsigned long nIns, unsigned long nOuts, unsigned long nAudioChans=0)
 
void setInputMode (unsigned long idx, bool update, bool trigger, bool switchable, FrameType type=kFrameNormal)
 
void setParameterInput (unsigned long idx)
 
void addParameterInput ()
 
void setOutputType (unsigned long idx, FrameType type)
 
void setCurrentOutputType (unsigned long idx, FrameType type)
 
void updateTrigger (unsigned long idx, bool trigger)
 
bool isTrigger (unsigned long idx) const
 
FrameLib_TimeFormat getFrameTime () const
 
FrameLib_TimeFormat getValidTime () const
 
FrameLib_TimeFormat getInputTime () const
 
FrameLib_TimeFormat getCurrentTime () const
 
FrameLib_TimeFormat getBlockStartTime () const
 
FrameLib_TimeFormat getBlockEndTime () const
 
FrameLib_TimeFormat getInputFrameTime (unsigned long idx) const
 
FrameLib_TimeFormat getInputValidTime (unsigned long idx) const
 
void requestOutputSize (unsigned long idx, size_t size)
 
void requestAddedOutputSize (unsigned long idx, size_t size)
 
bool allocateOutputs ()
 
FrameType getInputCurrentType (unsigned long idx) const
 
const double * getInput (unsigned long idx, size_t *size) const
 
const FrameLib_Parameters::Serial * getInput (unsigned long idx) const
 
FrameType getOutputCurrentType (unsigned long idx) const
 
double * getOutput (unsigned long idx, size_t *size) const
 
FrameLib_Parameters::Serial * getOutput (unsigned long idx) const
 
void prepareCopyInputToOutput (unsigned long inIdx, unsigned long outIdx)
 
void copyInputToOutput (unsigned long inIdx, unsigned long outIdx)
 
FrameLib_TimeFormat hzToSamples (const FrameLib_TimeFormat &a)
 
FrameLib_TimeFormat msToSamples (const FrameLib_TimeFormat &a)
 
FrameLib_TimeFormat secondsToSamples (const FrameLib_TimeFormat &a)
 
double hzToSamples (double a)
 
double msToSamples (double a)
 
double secondsToSamples (double a)
 
- Protected Member Functions inherited from FrameLib_Object< FrameLib_Block >
void addOutputDependencies (Queue *queue)
 
void addOutputDependencies (Queue *queue, unsigned long outIdx)
 
Connection getConnectionInternal (unsigned long inIdx) const
 
Connection getOrderingConnectionInternal (unsigned long idx) const
 
void setIO (unsigned long nIns, unsigned long nOuts, unsigned long nAudioChans=0)
 
void enableOrderingConnections ()
 
U * alloc (unsigned long N)
 
void dealloc (U *&ptr)
 
void clearAllocator ()
 
FrameLib_LocalAllocator::Storage * registerStorage (const char *name)
 
void releaseStorage (FrameLib_LocalAllocator::Storage *&storage)
 
const double * getEmptyFixedInput (unsigned long idx, unsigned long *size)
 

Additional Inherited Members

- Public Types inherited from FrameLib_Object< FrameLib_Block >
using Queue = typename FrameLib_Queueable< FrameLib_Block >::Queue
 
- Static Protected Member Functions inherited from FrameLib_DSP
static void copyVector (double *output, const double *input, unsigned long size)
 
static void zeroVector (double *output, unsigned long size)
 
static void copyVectorExtend (double *output, const double *input, unsigned long sizeOut, unsigned long sizeIn)
 
static void copyVectorWrap (double *output, const double *input, unsigned long sizeOut, unsigned long sizeIn)
 
static void copyVectorZero (double *output, const double *input, unsigned long sizeOut, unsigned long sizeIn)
 
- Static Protected Member Functions inherited from FrameLib_Object< FrameLib_Block >
static const char * formatInfo (const char *verboseStr, const char *briefStr, bool verbose)
 
static std::string formatInfo (const char *str, unsigned long idx)
 
static std::string formatInfo (const char *verboseStr, const char *briefStr, unsigned long idx, bool verbose)
 
static std::string formatInfo (const char *str, const char *replaceStr)
 
static std::string formatInfo (const char *verboseStr, const char *briefStr, const char *replaceStr, bool verbose)
 
static std::string parameterInputInfo (bool verbose)
 
static std::string numberedString (const char *str, unsigned long idx)
 
static bool addUniqueItem (std::vector< U > &list, U item)
 
static bool deleteUniqueItem (std::vector< U > &list, U item)
 
- Protected Attributes inherited from FrameLib_DSP
double mSamplingRate
 
unsigned long mMaxBlockSize
 
FrameLib_Parameters mParameters
 

Detailed Description

a convenience class for creating scheduler type FrameLib_DSP classes.

Scheduler classes schedule frames and may deal with block-based audio input (but not audio ioutput). This object provides an empty implementation of process() to avoid the end class developer needing to override this method (never called by a scheduler class).

Constructor & Destructor Documentation

◆ FrameLib_Scheduler()

FrameLib_Scheduler::FrameLib_Scheduler ( FrameLib_Context  context,
FrameLib_Proxy *  proxy,
FrameLib_Parameters::Info *  info,
unsigned long  nIns = 0,
unsigned long  nOuts = 0,
unsigned long  nAudioIns = 0 
)
inline

Member Function Documentation

◆ getType()

static ObjectType FrameLib_Scheduler::getType ( )
inlinestatic

◆ handlesAudio()

static bool FrameLib_Scheduler::handlesAudio ( )
inlinestatic

◆ process()

virtual void FrameLib_Scheduler::process ( )
inlineprotectedvirtual

Implements FrameLib_DSP.

The documentation for this class was generated from the following file: